docs: fix execution_graph README Quick Start and test READMEs in CI#92
Closed
no-materials wants to merge 1 commit into
Closed
docs: fix execution_graph README Quick Start and test READMEs in CI#92no-materials wants to merge 1 commit into
no-materials wants to merge 1 commit into
Conversation
… in CI The execution_graph README Quick Start dropped `?` on `add_node` and `set_input_value` (both return `Result`), so the `fn main()` example failed to compile with two E0308s. A reader's first copy-paste from the docs would not build, while the lib.rs doctest stayed correct because only it was exercised by CI. To stop this drift recurring, include each crate's README.md as a `#[cfg(doctest)]` item so the existing `cargo test --doc --workspace` step compiles the Quick Start. The item exists only under `cfg(doctest)`, so it never appears in rendered docs and is invisible to clippy and normal builds. execution_tape's README already compiled; its guard is purely protective.
Contributor
|
I think I'd prefer using |
Contributor
Author
Agreed, I'll open a dedicated PR for that. 👍 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fix the
execution_graphREADME Quick Start (missing?→ two E0308s), and guard both crates' READMEs with a#[cfg(doctest)]include so CI'scargo test --dockeeps them compiling.